GetOrdersByPurchaseOrder (Method)

Description

Retrieves posted sales orders linked to the shopper's current customer filtered by the supplied purchase order number.Retrieves posted sales orders linked to the shopper's current customer filtered by the supplied purchase order number. Introduced in v2.21.

Request (GetOrdersByPurchaseOrderSoapIn)

The request body is of type GetOrdersByPurchaseOrder.

Request Body Parameters

Name	Description	Data Type
CustomerPO	A customer purchase order number.	xml:string

Example

Javascript

MakeAJAXCall("Order.GetOrdersByPurchaseOrder", {
    CustomerPO: '435345'
}, console.log)

200 Response (GetOrdersByPurchaseOrderSoapOut)

The response body is of type GetOrdersByPurchaseOrderResponse.

Response Body Parameters

Name	Description	Data Type
GetOrdersByPurchaseOrderResult	A string value containing a JSON object. { "Data": [{ "SalesOrder": "001203", "Customer": "000000000000002", "CustomerName": "Bikes and Blades - North", "OrderStatus": "1", "Branch": "10", "OrderType": "", "Area": "N", "AlternateKey": "WEB108", "NextDetailLine": " 5", "DocumentType": "ORD", "Salesperson": "100", "Currency": "$", "CustomerPoNumber": "9678456735", "ShipViaCode": "", "ShippingInstrs": "FREE Ground Shipping", "SpecialInstrs": "", "OrderDate": "2020-04-15", "ReqShipDate": "2020-04-15", "OrderStatusText": "Open Order" }], "Result": { "Success": true, "Message": "The request returned 1 order results.", "ElapsedTime": "86 ms" } }	xml:string

Name

Description

Data Type

GetOrdersByPurchaseOrderResult

A string value containing a JSON object.

{
    "Data": [{
        "SalesOrder": "001203",
        "Customer": "000000000000002",
        "CustomerName": "Bikes and Blades - North",
        "OrderStatus": "1",
        "Branch": "10",
        "OrderType": "",
        "Area": "N",
        "AlternateKey": "WEB108",
        "NextDetailLine": "    5",
        "DocumentType": "ORD",
        "Salesperson": "100",
        "Currency": "$",
        "CustomerPoNumber": "9678456735",
        "ShipViaCode": "",
        "ShippingInstrs": "FREE Ground Shipping",
        "SpecialInstrs": "",
        "OrderDate": "2020-04-15",
        "ReqShipDate": "2020-04-15",
        "OrderStatusText": "Open Order"
    }],
    "Result": {
        "Success": true,
        "Message": "The request returned 1 order results.",
        "ElapsedTime": "86 ms"
    }
}

xml:string